<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.grid</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;grid
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.grid-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module grid</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#export_data" class="summary-sig-name">export_data</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      Use this command to export 2D analysis grid data as a comma separated
      value (*.CSV) file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#export_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#import_data" class="summary-sig-name">import_data</a>(<span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">import_op</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      This command imports data from an external coma separated value (*.CSV) 
file into the 2D analysis grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#import_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#fit_selection" class="summary-sig-name">fit_selection</a>(<span class="summary-sig-arg">fit_form</span>=<span class="summary-sig-default">True</span>)</span><br />
      Fits the analysis grid to the extents of currently selected objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#fit_selection">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#fit_values" class="summary-sig-name">fit_values</a>()</span><br />
      Calculates the optimum scale required to fit the full range of 
      currently visible grid values.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#fit_values">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      This command loads any analysis grid stored as a (*.GRD) binary data 
      file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#reset" class="summary-sig-name">reset</a>()</span><br />
      Use this command to reset all grid values back to zero.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#reset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">filename</span>)</span><br />
      This command saves the analysis grid as a (*.GRD) binary data file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#save">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#show" class="summary-sig-name">show</a>(<span class="summary-sig-arg">show</span>=<span class="summary-sig-default">True</span>)</span><br />
      Displays the current analysis grid in the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#show">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_average" class="summary-sig-name">get_average</a>()</span><br />
      Getting this property returns three values - the average value of all
      enabled grid nodes, the number of enabled grid nodes, and the 
      fraction of enabled nodes above the clipping threshold (the minimum 
      scale value).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_average">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_axis" class="summary-sig-name">get_axis</a>()</span><br />
      Retrieves the grid axis, being the axis within which the 2D slice has
      been drawn.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_axis">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_axis" class="summary-sig-name">set_axis</a>(<span class="summary-sig-arg">axis</span>)</span><br />
      Sets the grid axis, being the axis within which the 2D slice has been
      drawn.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_axis">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_cell" class="summary-sig-name">get_cell</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Retrieves the value stored in the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_cell">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_cell" class="summary-sig-name">set_cell</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Sets the value to be stored in the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_cell">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_data" class="summary-sig-name">get_data</a>()</span><br />
      Each grid cell of the analysis grid can store up to 5 different 
      values, as displayed within the selection list in the DATA &amp; 
      SCALE section of the Analysis Grid Panel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_data" class="summary-sig-name">set_data</a>(<span class="summary-sig-arg">index</span>)</span><br />
      Each grid cell of the analysis grid can store up to 5 different 
      values.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_data">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_description" class="summary-sig-name">get_description</a>(<span class="summary-sig-arg">index</span>)</span><br />
      Each cell of the analysis grid can store up to 5 different values, 
      each in an individual slot.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_description">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_description" class="summary-sig-name">set_description</a>(<span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">description</span>)</span><br />
      Each cell of the analysis grid can store up to 5 different values, 
      each in an individual slot.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_description">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_flag" class="summary-sig-name">get_flag</a>(<span class="summary-sig-arg">flag</span>)</span><br />
      The analysis grid uses a series of boolean flags to control how it is 
displayed in both the View and OpenGL canvasses.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_flag" class="summary-sig-name">set_flag</a>(<span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      The analysis grid uses a series of boolean flags to control how it is 
displayed in both the View and OpenGL canvasses.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_fraction" class="summary-sig-name">set_fraction</a>(<span class="summary-sig-arg">fraction</span>)</span><br />
      This property is a shortcut for setting the grid base offset when 
      animating through 3D data.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_fraction">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_max_extent" class="summary-sig-name">get_max_extent</a>()</span><br />
      Retreives the values for the maximum extent of the grid for the x y 
      and z axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_max_extent">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_max_extent" class="summary-sig-name">set_max_extent</a>(<span class="summary-sig-arg">absolute_position</span>)</span><br />
      Sets the maximum values of the grid extents for the x, y and z axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_max_extent">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_min_extent" class="summary-sig-name">get_min_extent</a>()</span><br />
      Retreives the values for the minimum extent of the grid for the x y 
      and z axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_min_extent">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_min_extent" class="summary-sig-name">set_min_extent</a>(<span class="summary-sig-arg">absolute_position</span>)</span><br />
      Sets the minimum values of the grid extents in theX, Y and Z axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_min_extent">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_offset" class="summary-sig-name">get_offset</a>()</span><br />
      Retrieves the grid base value, the offset distance of the 2D grid 
      section from the base of the 3D grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_offset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_offset" class="summary-sig-name">set_offset</a>(<span class="summary-sig-arg">offset</span>)</span><br />
      Sets the grid base value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_offset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_position" class="summary-sig-name">get_position</a>(<span class="summary-sig-arg">position</span>)</span><br />
      Retrieves the position of a grid point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_position">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_position" class="summary-sig-name">set_position</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">pos</span>)</span><br />
      Sets the position of a grid point.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_position">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_range" class="summary-sig-name">get_range</a>()</span><br />
      Getting this property returns the minimum and maximum base offsets in
      the current axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_range">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_scale" class="summary-sig-name">get_scale</a>()</span><br />
      Returns the scale values used to colour the grid and define the 
      number of contours displayed.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_scale" class="summary-sig-name">set_scale</a>(<span class="summary-sig-arg">min</span>,
        <span class="summary-sig-arg">max</span>,
        <span class="summary-sig-arg">inc</span>)</span><br />
      Sets the scale range values used to colour the grid and define the 
      number of contours displayed.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_size" class="summary-sig-name">get_size</a>(<span class="summary-sig-arg">grid_cells</span>)</span><br />
      Sets the number of cells to use with the current analysis grid, for 
      each of its axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_size">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_state" class="summary-sig-name">get_state</a>(<span class="summary-sig-arg">position</span>)</span><br />
      Retrieves the state of the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_state">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_state" class="summary-sig-name">set_state</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">state</span>)</span><br />
      Sets the state of the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_state">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_title" class="summary-sig-name">get_title</a>()</span><br />
      Retrieves the title of the current analysis grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_title" class="summary-sig-name">set_title</a>(<span class="summary-sig-arg">title</span>)</span><br />
      Sets the title of the current analysis grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_units" class="summary-sig-name">get_units</a>(<span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Retrieves the units of measurement used for the values stored in the 
      analysis grid, such as Lux or W/m^2.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_units">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_units" class="summary-sig-name">set_units</a>(<span class="summary-sig-arg">units</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Sets the units of measurement used for the values stored in the 
      analysis grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_units">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_vector" class="summary-sig-name">get_vector</a>(<span class="summary-sig-arg">position</span>)</span><br />
      Retrieves the vector value stored in the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_vector">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#set_vector" class="summary-sig-name">set_vector</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Sets the vector value stored in the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_vector">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid-module.html#get_zone" class="summary-sig-name">get_zone</a>(<span class="summary-sig-arg">position</span>,
        <span class="summary-sig-arg">axis</span>=<span class="summary-sig-default">0</span>,
        <span class="summary-sig-arg">draw</span>=<span class="summary-sig-default">False</span>)</span><br />
      Attempts to determine the zone within which the grid cell resides.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_zone">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="export_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">export_data</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#export_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to export 2D analysis grid data as a comma separated 
  value (*.CSV) file. The file will be saved into the current model 
  directory by default.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename This parameter specifies the file where the data will be 
  saved, and may include a full pathname. However, be aware of the issues 
  with backslashes in filename parameters described here.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="import_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">import_data</span>(<span class="sig-arg">filename</span>,
        <span class="sig-arg">import_op</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#import_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


This command imports data from an external coma separated value (*.CSV) 
file into the 2D analysis grid.

When importing grid data you can perform a range of operations to 
transform the grid information, where XXX can be one of the values shown 
in the following table. 

Parameter(s)
This command takes the following parameters.

filename 
This parameter specifies the file where the data will be imported from, 
and may include a full pathname. However, be aware of the issues with 
backslashes in filename parameters described here.

import_op
Refer to table below 

Relevant Data Table(s)

Grid Import Operations 
Command Suffix Description 
        If no value is appended, current grid data is overwritten. 
subtract Subtract imported data from existing data. 
add Add imported data to existing data. 
divide Divide existing data by imported data. 
percentage Show existing data as a percentage of imported data. 

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="fit_selection"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fit_selection</span>(<span class="sig-arg">fit_form</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#fit_selection">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Fits the analysis grid to the extents of currently selected objects. 
  This is the same as selecting the Fit to Selected Objects button in the 
  Analysis Grid panel. Calling this method updates the grid.max, grid.min 
  and grid.average properties.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[fit_form] This optional parameter determines whether the grid fits to
  the form as well as the extents of the selected objects. This is a 
  boolean value where 1 or true represents the affirmative and 0 or false 
  the negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="fit_values"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fit_values</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#fit_values">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Calculates the optimum scale required to fit the full range of 
  currently visible grid values. Calling this method updates the grid.scale
  property.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command loads any analysis grid stored as a (*.GRD) binary data 
  file. The loaded file contains both 2D and 3D grid data (if it exists) as
  well as all other grid settings.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename This parameter specifies the file where the data will be 
  imported from and may include a full pathname. However, be aware of the 
  issues with backslashes in filename parameters described here.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reset</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#reset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to reset all grid values back to zero.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>(<span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#save">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command saves the analysis grid as a (*.GRD) binary data file. 
  The saved file contains both 2D and 3D grid data (if it exists) as well 
  as all other grid settings.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename This parameter specifies the file where the data will be 
  imported from, and may include a full pathname. However, be aware of the 
  issues with backslashes in filename parameters described here.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="show"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">show</span>(<span class="sig-arg">show</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#show">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Displays the current analysis grid in the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>show When given, this optional parameter determines whether to show or
  hide the analysis grid in the main model view. This is a boolean value 
  where 1 or true represents the affirmative and 0 or false the negative. 
  If not specified, this defaults to true.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_average"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_average</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_average">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Getting this property returns three values - the average value of all 
  enabled grid nodes, the number of enabled grid nodes, and the fraction of
  enabled nodes above the clipping threshold (the minimum scale value). 
  This last value is only calculated when the Clip to Minimum option is 
  selected.</p>
  <p>Grids are generally rectilinear in shape. However, more complex shapes
  can be accommodated using a large grid with some disabled nodes - this is
  how the Fit Grid to Selected Objects button works. Note that the above 
  values are based on the number of enabled nodes in the grid, irrespective
  of whether they are visible or not due to a clipping threshold.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>avgValue The average value of all enabled nodes within the currently 
  displayed grid.</p>
  <p>nodeCount The number of enabled nodes within the currently displayed 
  grid.</p>
  <p>fractAbove The fraction of enabled nodes whose current data value is 
  above the minimum scale when the Clip to Minimum option is selected for 
  the currently displayed grid.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_axis"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_axis</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_axis">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the grid axis, being the axis within which the 2D slice has 
  been drawn. The value returned is a single integer value corresponding 
  with the following table.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>axis An integer value representing the current grid axis with a value 
  from the following Grid Axis table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Axis Value Axis 0 XY Axis 1 YZ Axis 2 XZ Axis</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_axis"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_axis</span>(<span class="sig-arg">axis</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_axis">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the grid axis, being the axis within which the 2D slice has been 
  drawn.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>axis A single integer value corresponding with the following Grid Axis
  table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Axis Value Axis 0 XY Axis 1 YZ Axis 2 XZ Axis</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_cell"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_cell</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_cell">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the value stored in the specified grid cell. Two values are 
  returned - the first is the actual value of the cell in the current 
  units, whilst the second is the state of the cell. The possible state 
  values that can be returned are given in the following table. Each grid 
  cell can store up to 5 different data values.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the required cell within the grid. Each must be an 
  integer between 0 and the current grid size - 1 in the relevant grid 
  axis.</p>
  <p>[index] This optional parameter specifies the index of the specified 
  data value to be retieved and can be an integer between 0 and 4. If this 
  parameter is not specified, the currently selected data index is 
  used.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value The current data value at the specified grid cell.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_cell"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_cell</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">value</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_cell">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the value to be stored in the specified grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant grid axis.</p>
  <p>value This parameter is the decimal value to be stored within the 
  cell.</p>
  <p>[index] Each grid cell can store up to 5 different data values. This 
  optional parameter specifies which particular slot the specified value 
  should be stored in, and can be an integer between 0 and 4. If this 
  parameter is not specified, the currently displayed index is used by 
  default.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_data</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Each grid cell of the analysis grid can store up to 5 different 
  values, as displayed within the selection list in the DATA &amp; SCALE 
  section of the Analysis Grid Panel. This property gets the currently 
  displayed data index.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The index of the grid cell data currently displayed. This is 
  given as an integer value in the range 0 to 4.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_data</span>(<span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_data">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Each grid cell of the analysis grid can store up to 5 different 
  values. This property sets the grid cell index to be displayed.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The index of the grid cell data to be displayed, given as an 
  integer value in the range 0 to 4.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_description"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_description</span>(<span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_description">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Each cell of the analysis grid can store up to 5 different values, 
  each in an individual slot. This command returns the description for the 
  specified slot. If no slot is specified, the description returned is for 
  the currently selected index.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index This optional parameter specifies the particular slot to return 
  the description for, and can be an integer in the range 0 to 4.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>description A text string containing the description of the nominated 
  slot.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_description"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_description</span>(<span class="sig-arg">index</span>,
        <span class="sig-arg">description</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_description">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Each cell of the analysis grid can store up to 5 different values, 
  each in an individual slot. This command sets the description for the 
  specified slot. If no slot is specified, the description is set for the 
  currently displayed index.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index This optional parameter specifies the particular slot to set the
  description for, and can be an integer in the range 0 to 4.</p>
  <p>description The description to be used for the nominated slot.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag</span>(<span class="sig-arg">flag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


The analysis grid uses a series of boolean flags to control how it is 
displayed in both the View and OpenGL canvasses. This property returns 
the current state for the flag value/s specified. 

Parameter(s)
This property takes the following parameters.

flag 
An integer that specifies which flag state to return, according to the 
following Grid Flags table

To return the values for multiple flags at once, add their respective 
values together. For example, using an integer value of 18 will return 
the state for both the values and contours flags. 

Return Value(s)
Getting this property returns the following value(s).

[state] 
The state of the specified flag(s). This is a boolean value where 1 or 
true represents the affirmative and 0 or false the negative. 

Relevant Data Table(s)

Grid Flag Codes 
Token Value Description 
axis 1 Display grid axis with units. 
values 2 Display text values at each grid node. 
extents 4 Display a bounding box showing the full 3D grid space. 
 8 UNUSED. 
contours 16 Display contours if variable data is available. 
selected 32 Display text values at selected grid nodes only. 
peaks 64 Display text values at peaks and troughs between values. 
colours 128 Display colour-shaded grid squares. 
 256 UNUSED. 
elastic 512 Use elastic method when dragging axial nodes. 
 1024 UNUSED. 
clip 2048 Clip the displayed grid to those nodes above the minimum range. 
average 4096 Display the average of all visible values at bottom of 
canvas. 
lines 8192 Display grid lines. 
3d 16384 Display grid values as a 3D peturbed surface. 
daylight 32768 Indicates that grid displays valid daylight analysis 
results. 

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag</span>(<span class="sig-arg">flag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


The analysis grid uses a series of boolean flags to control how it is 
displayed in both the View and OpenGL canvasses. This property sets the 
current state for the flag value/s specified. 

Parameter(s)
This property takes the following parameters.

flag 
An integer that specifies which flag state to set, according to the 
following Grid Flags table.

To set the values for multiple flags at once, add their respective 
values together. For example, using an integer value of 18 will set the 
state for both the values and contours flags. 

[state] 
This optional parameter determines if the specified flag(s) are set or 
not. This is a boolean value where 1 or true represents the affirmative 
and 0 or false the negative. If this paramater is not specified, the 
default state is set to true. 

Relevant Data Table(s)

Grid Flag Codes Token Value Description 
axis 1 Display grid axis with units. 
values 2 Display text values at each grid node. 
extents 4 Display a bounding box showing the full 3D grid space. 
 8 UNUSED. 
contours 16 Display contours if variable data is available. 
selected 32 Display text values at selected grid nodes only. 
peaks 64 Display text values at peaks and troughs between values. 
colours 128 Display colour-shaded grid squares. 
 256 UNUSED. 
elastic 512 Use elastic method when dragging axial nodes. 
 1024 UNUSED. 
clip 2048 Clip the displayed grid to those nodes above the minimum range. 
average 4096 Display the average of all visible values at bottom of 
canvas. 
lines 8192 Display grid lines. 
3d 16384 Display grid values as a 3D peturbed surface. 
daylight 32768 Indicates that grid displays valid daylight analysis 
results. 

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_fraction"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_fraction</span>(<span class="sig-arg">fraction</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_fraction">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This property is a shortcut for setting the grid base offset when 
  animating through 3D data. Instead of giving an absolute base offset 
  using the set.grid.offset property, you can instead set the fraction of 
  the 2D grid section between the minimum and maximum extents in the 3D 
  grid.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>fraction A decimal number between 0 and 1. This property can also be 
  used to cycle through indexed grid animation frames using the 
  grid3d.setframe command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_max_extent"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_max_extent</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_max_extent">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retreives the values for the maximum extent of the grid for the x y 
  and z axes. The axial values are given in absolute world 
  co-ordinates.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z The absolute position in the X, Y and Z axis of the maximun 
  extents of the analysis grid in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_max_extent"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_max_extent</span>(<span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_max_extent">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the maximum values of the grid extents for the x, y and z axes. 
  The axial values are specified in absolute world co-ordinates.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represent the absolute 
  position in the X, Y and Z axis of the maximun extents of the analysis 
  grid in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_min_extent"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_min_extent</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_min_extent">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retreives the values for the minimum extent of the grid for the x y 
  and z axes. The axial values are given in absolute world 
  co-ordinates.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z The absolute position in the X, Y and Z axis of the minimun 
  extents of the analysis grid in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_min_extent"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_min_extent</span>(<span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_min_extent">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the minimum values of the grid extents in theX, Y and Z axes.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represent the absolute 
  position in the X, Y and Z axis of the minimun extents of the analysis 
  grid in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_offset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_offset</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_offset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the grid base value, the offset distance of the 2D grid 
  section from the base of the 3D grid. See the grid.axis command for more 
  information.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>offset The offset distance of the 2D grid section from the base of the
  3D grid, for the currently selected axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_offset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_offset</span>(<span class="sig-arg">offset</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_offset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the grid base value. If full 3D grid values have been calculated,
  you can use this value to animate the grid by cycling between the minimum
  and maximum range in the current axis.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>base The offset distance of the 2D grid section from the base of the 
  3D grid, for the currently selected axis. See the grid.axis</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_position"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_position</span>(<span class="sig-arg">position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_position">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the position of a grid point. Three values are returned, 
  being the x y and z coordinates of the specified cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant grid axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of the
  grid cell node in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_position"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_position</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">pos</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_position">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the position of a grid point. Note that setting this value is 
  only possible when the grid has been form fit to selected objects using 
  the grid.fit.selection command, or by selecting the Fit to Selected 
  Objects &gt; 3D Form button in the Analysis Grid panel.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant axis.</p>
  <p>pos This parameter is the absolute world coordinate of the cell in the
  current grid axis. Thus if the axis is currently set to XY (0), then a 
  value of 1500 would equate to a height of 1.5m in the z axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_range"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_range</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_range">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Getting this property returns the minimum and maximum base offsets in 
  the current axis. The base offset property of the grid will therefore be 
  within these two values. This is basically a shortcut to the grid.min and
  grid.max where only values for the currently selected grid axis are 
  returned.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>min The minimum value in the current grid axis.</p>
  <p>max The maximum value in the current grid axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_scale</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the scale values used to colour the grid and define the number
  of contours displayed. Three values are returned, being the minimum 
  scale, the maximum scale, and the increments used to draw the 
  contours.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>min The minimum scale value.</p>
  <p>max The maximum scale value.</p>
  <p>inc The increment size used to draw contours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_scale</span>(<span class="sig-arg">min</span>,
        <span class="sig-arg">max</span>,
        <span class="sig-arg">inc</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the scale range values used to colour the grid and define the 
  number of contours displayed.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>min The minimum scale value.</p>
  <p>max The maximum scale value.</p>
  <p>inc The increment size used to draw contours.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_size"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_size</span>(<span class="sig-arg">grid_cells</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_size">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the number of cells to use with the current analysis grid, for 
  each of its axes.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>grid_cells A list of three values that represent that define the 
  number of grid cells to create in each of the X, Y and Z axis directions 
  of the analysis grid. If Z axis is not specified, the analysis grid 
  becomes a 2D analysis grid.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_state"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_state</span>(<span class="sig-arg">position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_state">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the state of the specified grid cell. The possible values 
  returned correspond with the following table.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state An integer value representing the state of the specified cell, 
  according to the following Grid Cell State table</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Cell State Codes Value Description 1 Visible and selected. 0 
  Visible but not selected. -99 Disabled. -100 Hidden. -100 Hidden and 
  selected.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_state"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_state</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_state">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the state of the specified grid cell. The possible values 
  returned correspond with the following table.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant axis.</p>
  <p>state This parameter is an integer value that controls how the 
  specified cell is to be acted upon and displayed, according to the 
  following Grid Cell State table</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Cell State Codes Value Description 1 Visible and selected. 0 
  Visible but not selected. -99 Disabled. -100 Hidden. -100 Hidden and 
  selected.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_title</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the title of the current analysis grid.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>title A text string up to 64 characters in length.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_title</span>(<span class="sig-arg">title</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the title of the current analysis grid.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>title A text string up to 64 characters in length containing the new 
  title.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_units"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_units</span>(<span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_units">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the units of measurement used for the values stored in the 
  analysis grid, such as Lux or W/m^2.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[index] Each grid cell can store up to 5 different values and units of
  measurement. This optional parameter specifies which slot to retrieve the
  units for and can be an integer in the range 0 to 4. If not specified, 
  the currently selected index is used by default.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>units A text string containing the units name of the nominated 
  slot.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_units"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_units</span>(<span class="sig-arg">units</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_units">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the units of measurement used for the values stored in the 
  analysis grid.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index Each grid cell can store up to 5 different values and units of 
  measurement. The optional [index] parameter specifies which slot to 
  change the units for, and can be an integer in the range 0 to 4. If the 
  [index] parameter is not specified, the currently displayed index is used
  by default.</p>
  <p>units Specifies what units of measurement to use, and can be a short 
  string such as Lux or W/m^2.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_vector"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_vector</span>(<span class="sig-arg">position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_vector">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the vector value stored in the specified grid cell. Three 
  values are returned, being the x y and z components of the vector 
  value.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant grid axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dx, dy, dz A vector value representing the offset distance in each of 
  the X, Y and Z axis, given in model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_vector"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_vector</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#set_vector">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the vector value stored in the specified grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant grid axis.</p>
  <p>offset_distance A list of three values that represent the vector value
  representing the offset distance in each of the X, Y and Z axis, given in
  model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_zone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_zone</span>(<span class="sig-arg">position</span>,
        <span class="sig-arg">axis</span>=<span class="sig-default">0</span>,
        <span class="sig-arg">draw</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid-pysrc.html#get_zone">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Attempts to determine the zone within which the grid cell resides. 
  This is achieved by drawing a test ray in the direction specified by the 
  given axis. The first object hit by this ray gives the zone within which 
  this specified grid cell is located. If an axis value of 0 is used, only 
  FLOOR objects within each zone are checked - this is a very quick 
  calculation and is usualy the most appropriate axis.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>position A list of two values that represent the horizontal and 
  vertical position of the cell within the grid where the value is to be 
  stored. Each must be an integer between 0 and the current grid size - 1 
  in the relevant grid axis.</p>
  <p>[axis] Specifies the axis about which to trace the test ray, according
  to the following Grid Axis table. If not specified, the XY axis is used 
  and only FLOOR objects checked.</p>
  <p>[draw] This optional parameter determines if the test ray should be 
  drawn in the 3D EDITOR page or not. This is a boolean value where 1 or 
  true represents the affirmative and 0 or false the negative. If not 
  specified, the default setting is not to draw each test ray.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>zone The zero-based index of the zone within which the specified grid 
  cell is most likely located.</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Axis Value Axis 0 XY Axis 1 YZ Axis 2 XZ Axis</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
